.TH XNEURRC 5 
.SH NAME
xkeylogrc - configuration file for XNeur
.SH DESCRIPTION
.PP
In this file defined options for XNeur. May be created or changed manuallly or with \fIgXNeur\fP or \fIkXNeur\fP. Location for manual settings: ~/.xkeylog/xkeylogrc. Location of base settings: {prefix}/etc/xkeylog/xkeylogrc
.SH OPTIONS
.TP 8
.B Version <number>
Defines conformity of the configuration file to the program version. For XNeur version 0.5.0, the value of <number> is 0.5.0.
.TP 8
.B ManualMode <param>
Describes program working mode. Here, the value of <param> can be "Yes" or "No", which means, respectively, work in manual or automatic mode.

In the automatic mode, the program "on fly" determines the input language and switches the keyboard layout, at the same time changing the word typed in. In the manual mode, the program does not use algorithms of language recognition, layout switching and text conversion take place on user request by pressing hot keys. 
.TP 8
.B LogLevel <level>
Defines level of diagnostic output to console.

Here, <level> takes the values "Error", "Warning", "Log", "Debug", "Trace". By changing this parameter, the detail of output to console can be controlled. 
.TP 8
.B AddLanguage <language> <dir> <group> [Fixed]
Defines the language, with which the program will work.

Here, <language> stands for the language, for which the layout should be specified (English or Russian), <dir> is a subdirectory in ~/.xkeylog/, where a config file for this language is located, and <group> is layout number group for the language in the system (takes values from 0 to 3). Add word "Fixed" at the line's end if this layout excluded from processing.
.TP 8
.B DefaultXkbGroup <group>
Define initial keyboard layout for all new applications.

Here, <group> stands for the number of XKB layout for this language in the system (takes values from 0 to 3).
.TP 8
.B ExcludeApp <app_name>
Defines an application, in which the program WILL NOT work.

Here, <app_name> is an identifier of the program window, input in which is processed by XNeur.
<app_name> can be obtained with the xprop utility.
Multiple entries for this option in a single configuration file are allowed, like "one program - one option ExcludeApp". 
.TP 8
.B SetAutoApp <app_name>
Defines an application, in which the program will always work in the automatic mode, independent of the DefaultMode option.

Here, <app_name> is an identifier of the program window, input in which is processed by xkeylog.
app_name can be obtained with the xprop utility.
Multiple entries for this option in a single configuration file are allowed, like "one program - one option SetAutoApp". 
.TP 8
.B SetManualApp <app_name>
Defines an application, in which the program will always work in the manual mode, independent of the DefaultMode option.

Here, <app_name> is an identifier of the program window, input in which is processed by xkeylog.
app_name can be obtained with the xprop utility.
Multiple entries for this option in a single configuration file are allowed, like "one program - one option SetManualApp". 
.TP 8
.B AddBind <action> [Control | Alt | Shift | Super] [key]
Defines hot keys for xkeylog control.

Here, <action> stands for an action of XNeur, <key> stands for a special key.

<action> takes the following values: "ChangeWord" (replace word/cancel last auto replacement), 
"ChangeString" (replace last string), "ChangeMode" (switch between the auto and the manual program modes), 
"ChangeSelected" (convert selected text to another layout), "TranslitSelected" (convert selected Cyrillic test to translit),
"ChangecaseSelected" (change lettercase of selected text), "EnableLayout1" (enable of first layout),
"EnableLayout2" (enable of second layout), "EnableLayout3" (enable of third layout), "EnableLayout4" (enable of fourth layout) or "ReplaceAbbreviation" (replace abbreviation to full text).

[key] takes the values defined in your latin keyboard. Skip this value if hot key undefined.
.TP 8
.B AddAction [Control | Alt | Shift | Super] <key> <action>
Defines hot keys for user actions.

Here, <action> is user actions (e.g. firefox or gnome-terminal), <key> stands for a special key.

<key> takes the values defined in your latin keyboard.
.TP 8
.B ReplaceAbbreviationIgnoreLayout <param>
This option enable or disable of the ignore keyboard layout for abbreviations list.

Here, <param> takes the values "Yes", "No".
.TP 8
.B ReplaceAbbreviation <abbreviation> <full_text>
Define an abbreviation, which be replased to full text.

Here, <abbreviation> is abreviation and <full_text> is text.
Multiple entries for this option in a single configuration file are allowed, like "one abbreviation - one option ReplaceAbbreviation". 
.TP 8
.B PlaySound <param>
This option enable or disable sound playing.

Here, <param> takes the values "Yes", "No".
.TP 8
.B AddSound <action> <sound>
Binds sounds for some actions.

Here, <action> takes the following values: "XneurStart", "XneurReload", "XneurStop", "PressKeyLayout1", "PressKeyLayout2", "PressKeyLayout3", "PressKeyLayout4",
"EnableLayout1", "EnableLayout2", "EnableLayout3", "EnableLayout4",
"AutomaticChangeWord", "ManualChangeWord", "ChangeString", "ChangeSelected", "TranslitSelected", "ChangecaseSelected" and "ReplaceAbbreviation", "CorrectIncidentalCaps", "CorrectTwoCapitalLetter", "ExecuteUserAction".

<sound> is .wav file placed in ~/.xkeylog/sounds or in basic place ({prefix}/share/xkeylog/sounds/).
.TP 8
.B GrabMouse <param>
Defines, if xkeylog will intercept mouse events to clear its buffer.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B EducationMode <param>
Defines, if XNeur will work in self-training. A wrong input will be added to the dictionary, if it is twice converted into a specific layout manually. If this option is on, this will lead to a bigger dictionary. Does not make sence for the manual operating mode.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B LayoutRememberMode <param>
This option enable or disable layout remember for each window

Here, <param> takes the values "Yes", "No". 
.TP 8
.B SaveSelectionMode <param>
Define, if a selection will stay after changes, made by user actions, defined by the AddBind parameter.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B SendDelay <value>
This option define delay in milliseconds before sendind events to application. 

Here, <value> must be until 0 to 50. 
.TP 8
.B SaveLog <param>
This option enable or disable logging keyboard. Log places in ~/.xkeylog/xkeyloglog

Here, <param> takes the values "Yes", "No". 
.TP 8
.B CorrectIncidentalCaps <param>
This option enable or disable correction of iNCIDENTAL CapsLock.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B CorrectTwoCapitalLetter <param>
This option enable or disable correction of two CApital letter.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B FlushBufferWhenPressEnter <param>
This option enable or disable flushing internal buffer when pressed Enter or Tab.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B DontProcessWhenPressEnter <param>
This option disable or enable processing word when pressed Enter or Tab.

Here, <param> takes the values "Yes", "No". 
.TP 8
.B ShowOSD <param>
This option disable or enable show OSD.

Here, <param> takes the values "Yes", "No".
.TP 8
.B FontOSD <param>
This option set font for OSD.

Here, <param> takes the value, that can be received with command "xfontsel -print".
.TP 8
.B AddOSD <action> <text>
Binds OSD for some actions.

Here, <action> takes the following values: "XneurStart", "XneurReload", "XneurStop", "PressKeyLayout1", "PressKeyLayout2", "PressKeyLayout3", "PressKeyLayout4",
"EnableLayout1", "EnableLayout2", "EnableLayout3", "EnableLayout4",
"AutomaticChangeWord", "ManualChangeWord", "ChangeString", "ChangeSelected", "TranslitSelected", "ChangecaseSelected" and "ReplaceAbbreviation", "CorrectIncidentalCaps", "CorrectTwoCapitalLetter", "ExecuteUserAction".

<text> is text will be displayed. For option "ExecuteUserAction" possible use pattern %s to display of the command.


.SH "SEE ALSO"
xkeylog(1), gxkeylog(1), kxkeylog(1)
.SH AUTHOR
Andrew Crew Kuznetsov, Nikolay Yankin
